﻿//-----------------------------------------------------------------------
// <copyright file="MessageFilterHelper.cs" company="AFS">
// Copyright (c) AFS. All rights reserved.
//
//    This file is part of Chatbox.
//
//    Chatbox is free software: you can redistribute it and/or modify
//    it under the terms of the GNU Lesser General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    any later version.
//
//    Chatbox is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
//    GNU Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public License
//    along with Chatbox. If not, see http://www.gnu.org/copyleft/lesser.html
// </copyright>
//----------------------------------------------------------------------- 
namespace ChatBox.UI.MessageFilters
{
    using System.Collections.Generic;
    using System.Linq;

    using DomainObjects.XmlFeedObjects;

    /// <summary>
    /// Helper methods for the IMessageFilter
    /// </summary>
    public static class MessageFilterHelper
    {
        /// <summary>
        /// Apply a filter to a list of messages
        /// </summary>
        /// <param name="messages">the messages to filter</param>
        /// <param name="filter">the filter to apply</param>
        /// <returns>the filtered list</returns>
        public static IEnumerable<Message> ApplyFilter(this IEnumerable<Message> messages, IMessageFilter filter)
        {
            if (filter == null)
            {
                return messages;
            }

            return messages.Where(m => filter.IsIncluded(m));
        }
    }
}
